home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / viewers / pvquan16 / readme < prev    next >
Text File  |  1992-12-01  |  9KB  |  216 lines
  1. Persistence of Vision Quantiser Utilities version 1.6
  2. =====================================================
  3.  
  4. SOURCE CODE  (PVQUAN16.ZIP)
  5. ===========================
  6.  
  7. Description
  8. ~~~~~~~~~~~
  9. This archive contains the source code for a set of programs to convert
  10. image files produced by DKB-Trace or the Persistence of Vision raytracer
  11. into a format suitable for display on a VGA screen, or to GIF format. It
  12. includes programs to generate a single stereoscopic 3D image from two
  13. views of a scene, as well as programs to produce animation from multiple
  14. ray-traced images.
  15.  
  16. QUANT (HECKBERT & OCTREE):
  17.   Colour quantisation program which post-processes raw image files
  18.   produced by the Persistence of Vision Ray Tracer (PoV Ray). Two
  19.   versions can be compiled: one uses Heckbert's median-splitting
  20.   algorithm, whereas the other uses Octree quantisation.
  21.  
  22. DISPLAY:
  23.   Displays either 320x400 or 320x200 images on a VGA screen, either 2D,
  24.   or stereo 3D. 3D images require Sega 3D-glasses to be connected to the
  25.   serial port for viewing.
  26.  
  27. ANIMDAT:
  28.   Reads an animation source file (*.VAR), and uses it to generate data
  29.   files for the PoV ray tracer.
  30.  
  31. ANIMFLI:
  32.   Produces a .FLI file containing a series of images to be displayed by
  33.   a .FLI player (e.g. Autodesk's AAPLAY).
  34.  
  35.  
  36. PVQUAN16.ZIP Archive contents
  37. =============================
  38.  
  39. This archive contains subdirectory information... unzip it using
  40.  
  41. PKUNZIP -d PVQUAN16
  42.  
  43. It will create a subdirectory tree in your current directory as follows:
  44.  
  45. pvquan ─┐               Sample files
  46.         ├─ quant        Heckbert and Octree quantisers
  47.         ├─ animdat      Animation Scene file generator
  48.         ├─ giflib       GIF encode/decode library
  49.         ├─ flilib       FLI creation library
  50.         ├─ anim         FLI creation source code
  51.         ├─ vga          VGA mode-X library
  52.         └─ display      VGA 3D display
  53.  
  54. Each directory contains source code, plus make-files to produce
  55. executable programs via MS-DOS, OS/2, or Unix.
  56.  
  57. You may also wish to create a BIN directory off the PVQUAN directory...
  58. the sample make-files attempt to place executable programs there.
  59.  
  60. To create your own executables:
  61.  
  62. 1.      In each directory, rename the appropriate version of the
  63.         makefile to MAKEFILE (e.g. REN MAKEDOS MAKEFILE if compiling for
  64.         DOS).
  65.  
  66.         Because both quantisers use common code, they are contained in
  67.         the same directory. This causes some problems in terms of naming
  68.         the makefiles.
  69.  
  70.         In MS-DOS, rename MAKEDOS.HEC to MAKEFILE to produce HECKBERT.EXE
  71.                    rename MAKEDOS.OCT to MAKEFILE to produce OCTREE.EXE
  72.  
  73.         In OS/2,   rename MAKEFILE.OCT to MAKEFILE to produce OCTREE.EXE
  74.                    rename MAKEHEC.DEP  to MAKEFILE.DEP to produce HECKBERT.EXE
  75.  
  76.         In Unix,   rename MAKEUNIX.HEC to MAKEFILE to produce HECKBERT
  77.                    rename MAKEUNIX.OCT to MAKEFILE to produce OCTREE
  78.  
  79. 2.      Edit each makefile to include the correct path to your compiler,
  80.         linker, executable location, etc.
  81.  
  82.         In MS-DOS, all source files compile and link cleanly (no
  83.         warnings, no errors) using Turbo C++ v1.0. Other versions of
  84.         Turbo-C should also work. Some editing will be required for
  85.         other compilers.
  86.  
  87.         In OS/2, all source files compile and link cleanly (no warnings,
  88.         no errors) using IBM's C Set/2 v1.0. Some editing will be
  89.         required for other compilers.
  90.  
  91.         In Unix, all source files compile and link cleanly (no warnings,
  92.         no errors) using GNU's gcc on a Sun IPC SPARCstation. The
  93.         previous version compiled cleanly under SCO's cc compiler on a
  94.         486 PC, but this version hasn't been tested with that. Some
  95.         editing will be required for other compilers.
  96.  
  97. 3.      Create FLI, GIF, and VGA libraries via MAKE. N.B. The OS/2
  98.         version does not use libraries. Instead the .OBJ files are
  99.         linked in directly.
  100.  
  101. 4.      Create executable programs via MAKE.
  102.  
  103. File Names
  104. ----------
  105. pvquan/
  106. pvquan/readme                   This file
  107. pvquan/pvquan.doc               Documentation on quantisers, etc.
  108. pvquan/bball.var                Bouncing ball animation
  109. pvquan/bball.pov                Scene description for bouncing ball
  110. pvquan/pacman.var               Pacman animation description
  111. pvquan/pacman.pov               Scene description for Pacman animation
  112. pvquan/pacman.iff               Part of Pacman scene
  113. pvquan/trace.sh                 Unix script to trace a scene in background
  114. pvquan/trace1.sh                Unix script (called by trace.sh)
  115. pvquan/anim.sh                  Unix script to create an animation
  116. pvquan/anim1.sh                 Unix script (called by anim.sh)
  117. pvquan/anim.cmd                 OS/2 (4OS2) script to create an animation
  118.  
  119. pvquan/quant/                   Quantisers directory
  120. pvquan/quant/heckbert.c         Heckbert quantisation
  121. pvquan/quant/heckbert.h
  122. pvquan/quant/octree.c           Octree quantisation
  123. pvquan/quant/octree.h
  124. pvquan/quant/virt_mem.c         Virtual memory (for TurboC & Heckbert)
  125. pvquan/quant/quant.c            Quantiser Main program
  126. pvquan/quant/quant.h
  127. pvquan/quant/files.c            File handling
  128. pvquan/quant/makeunix.oct       Unix Octree makefile
  129. pvquan/quant/makeunix.hec       Unix Heckbert makefile
  130. pvquan/quant/makedos.hec        Turbo C Heckbert makefile
  131. pvquan/quant/link.hec           Turbo C Heckbert TLINK commands
  132. pvquan/quant/makedos.oct        Turbo C Octree makefile
  133. pvquan/quant/link.oct           Turbo C Octree TLINK commands
  134. pvquan/quant/makefile.oct       OS/2 Octree makefile (rename to makefile)
  135. pvquan/quant/makefile.dep       OS/2 Octree make dependencies
  136. pvquan/quant/makehec.dep        OS/2 Heckbert dependencies (rename to makefile.dep)
  137. pvquan/quant/makefile.hec       OS/2 Heckbert makefile (don't rename)
  138.  
  139. pvquan/animdat/                 Animation scene description generator
  140. pvquan/animdat/readme.doc       Documentation for animdat
  141. pvquan/animdat/animdat.doc      Documentation for animdat
  142. pvquan/animdat/common.h
  143. pvquan/animdat/error.h
  144. pvquan/animdat/scanner.h
  145. pvquan/animdat/btree.h
  146. pvquan/animdat/symtab.h
  147. pvquan/animdat/bball.pov
  148. pvquan/animdat/bball.var
  149. pvquan/animdat/scanner.c
  150. pvquan/animdat/error.c
  151. pvquan/animdat/btree.c
  152. pvquan/animdat/animdat.c
  153. pvquan/animdat/symtab.c
  154. pvquan/animdat/makeunix         Unix makefile
  155. pvquan/animdat/makeos2          OS/2 makefile
  156. pvquan/animdat/makefile.dep     OS/2 make dependencies
  157. pvquan/animdat/makedos          Turbo C makefile
  158. pvquan/animdat/link.cmd         Turbo C TLINK commands
  159.  
  160. pvquan/giflib/                  GIF encode/decode library
  161. pvquan/giflib/gif_hash.c
  162. pvquan/giflib/gif_hash.h
  163. pvquan/giflib/egif_lib.c
  164. pvquan/giflib/gif_lib.h
  165. pvquan/giflib/dgif_lib.c
  166. pvquan/giflib/makeunix          Unix makefile
  167. pvquan/giflib/makeos2           OS/2 makefile
  168. pvquan/giflib/makefile.dep      OS/2 make dependencies
  169. pvquan/giflib/makedos           Turbo C makefile
  170.  
  171. pvquan/flilib/                  FLI encode library
  172. pvquan/flilib/aaerr.h
  173. pvquan/flilib/aascreen.h
  174. pvquan/flilib/aaflisav.h
  175. pvquan/flilib/aatypes.h
  176. pvquan/flilib/aafii.h
  177. pvquan/flilib/aafli.h
  178. pvquan/flilib/str_low.c         Low-level string handling (Unix, OS/2)
  179. pvquan/flilib/str_low.asm       Low-level string handling (Turbo C)
  180. pvquan/flilib/str_low.h
  181. pvquan/flilib/compfram.c
  182. pvquan/flilib/lccomp.c
  183. pvquan/flilib/creatfli.c
  184. pvquan/flilib/brun.c
  185. pvquan/flilib/copyscre.c
  186. pvquan/flilib/flierr.c
  187. pvquan/flilib/memscree.c
  188. pvquan/flilib/fccomp.c
  189. pvquan/flilib/makeunix          Unix makefile
  190. pvquan/flilib/makeos2           OS/2 makefile
  191. pvquan/flilib/makefile.dep      OS/2 make dependencies
  192. pvquan/flilib/makedos           Turbo C makefile
  193. pvquan/flilib/flilib.rsp        Turbo C TLIB commands
  194.  
  195. pvquan/anim/                    FLI generator program
  196. pvquan/anim/animfli.c
  197. pvquan/anim/makeunix            Unix makefile
  198. pvquan/anim/makeos2             OS/2 makefile
  199. pvquan/anim/makefile.dep        OS/2 make dependencies
  200. pvquan/anim/makedos             Turbo C makefile
  201. pvquan/anim/link.cmd            Turbo C TLINK commands
  202.  
  203. pvquan/vga/                     VGA 320x200, 320x400 screen library (Turbo C)
  204. pvquan/vga/vga.h
  205. pvquan/vga/vga200.c
  206. pvquan/vga/vga400.c
  207. pvquan/vga/vga_pal.c
  208. pvquan/vga/vga_retr.c
  209. pvquan/vga/makefile             Turbo C makefile
  210.  
  211. pvquan/display/                 VGA display program (Turbo C)
  212. pvquan/display/display.c
  213. pvquan/display/makefile         Turbo C makefile
  214.  
  215.  
  216.